/*
 * Copyright (c) 2006, 2007 FTS Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the FTS Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      ZoneInfo.hpp
 *
 * $FTS$
 */
#ifndef _ZONE_INFO_HPP__
#define _ZONE_INFO_HPP__ 1

#include <FTSTypes.h>

#include <string.h>

namespace FTSS // FullTextSearchSystem
{

/**
  @def C_MAX_ZONE_NAME_LENGTH
  @brief Maximun length of zone name
*/
#define C_MAX_ZONE_NAME_LENGTH 64
#define C_MAX_ZONES            32

#define C_ZONE_NOINDEX    0x00000001
#define C_ZONE_NUMZONE    0x00000002
#define C_ZONE_TEXTZONE   0x00000004
#define C_ZONE_PRIVATE    0x10000000
#define C_ZONE_UNUSED     0x80000000
/**
  @struct Zone ZoneInfo.hpp <ZoneInfo.hpp>
  @brief Document zone definition
*/
struct Zone
{
	/** Zone name  */
	CHAR_8     name[C_MAX_ZONE_NAME_LENGTH];
	/** Zone ID    */
	UINT_32    zone_id;
	/** Zone Flags */
	UINT_32    zone_flags;
};

} // namespace FTSS
#endif // _ZONE_INFO_HPP__
// End.
